ListCollectibles

POST /rpc/Marketplace/ListCollectibles

list of collectibles with best order for each collectible, by default this only returns collectibles with an order

cURL

curl --request POST \
  --url https://marketplace-api.sequence.app/amoy/rpc/Marketplace/ListCollectibles \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Key: <api-key>' \
  --data '
{
  "contractAddress": "<string>"
}
'

import requests

url = "https://marketplace-api.sequence.app/amoy/rpc/Marketplace/ListCollectibles"

payload = { "contractAddress": "<string>" }
headers = {
    "X-Access-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Access-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({contractAddress: '<string>'})
};

fetch('https://marketplace-api.sequence.app/amoy/rpc/Marketplace/ListCollectibles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://marketplace-api.sequence.app/amoy/rpc/Marketplace/ListCollectibles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'contractAddress' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Access-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://marketplace-api.sequence.app/amoy/rpc/Marketplace/ListCollectibles"

	payload := strings.NewReader("{\n  \"contractAddress\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Access-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://marketplace-api.sequence.app/amoy/rpc/Marketplace/ListCollectibles")
  .header("X-Access-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contractAddress\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://marketplace-api.sequence.app/amoy/rpc/Marketplace/ListCollectibles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Access-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"contractAddress\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "collectibles": [
    {
      "metadata": {
        "tokenId": "<string>",
        "name": "<string>",
        "attributes": [
          {}
        ],
        "description": "<string>",
        "image": "<string>",
        "video": "<string>",
        "audio": "<string>",
        "properties": {},
        "imageData": "<string>",
        "externalUrl": "<string>",
        "backgroundColor": "<string>",
        "animationUrl": "<string>",
        "decimals": 123,
        "updatedAt": "<string>",
        "assets": [
          {
            "id": 123,
            "collectionId": 123,
            "tokenId": "<string>",
            "metadataField": "<string>",
            "url": "<string>",
            "filename": "<string>",
            "filesize": 123,
            "mimeType": "<string>",
            "width": 123,
            "height": 123,
            "updatedAt": "<string>"
          }
        ]
      },
      "order": {
        "id": 123,
        "collectionId": 123,
        "orderId": "<string>",
        "chainId": 123,
        "originName": "<string>",
        "collectionContractAddress": "<string>",
        "createdBy": "<string>",
        "priceAmount": "<string>",
        "priceAmountFormatted": "<string>",
        "priceAmountNet": "<string>",
        "priceAmountNetFormatted": "<string>",
        "priceCurrencyAddress": "<string>",
        "priceDecimals": 123,
        "priceUSD": 123,
        "priceUSDFormatted": "<string>",
        "quantityInitial": "<string>",
        "quantityInitialFormatted": "<string>",
        "quantityRemaining": "<string>",
        "quantityRemainingFormatted": "<string>",
        "quantityAvailable": "<string>",
        "quantityAvailableFormatted": "<string>",
        "quantityDecimals": 123,
        "feeBps": 123,
        "feeBreakdown": [
          {
            "kind": "<string>",
            "recipientAddress": "<string>",
            "bps": 123
          }
        ],
        "validFrom": "<string>",
        "validUntil": "<string>",
        "blockNumber": 123,
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "collectibleId": 123,
        "tokenId": "<string>",
        "orderCreatedAt": "<string>",
        "orderUpdatedAt": "<string>",
        "deletedAt": "<string>"
      },
      "listing": {
        "id": 123,
        "collectionId": 123,
        "orderId": "<string>",
        "chainId": 123,
        "originName": "<string>",
        "collectionContractAddress": "<string>",
        "createdBy": "<string>",
        "priceAmount": "<string>",
        "priceAmountFormatted": "<string>",
        "priceAmountNet": "<string>",
        "priceAmountNetFormatted": "<string>",
        "priceCurrencyAddress": "<string>",
        "priceDecimals": 123,
        "priceUSD": 123,
        "priceUSDFormatted": "<string>",
        "quantityInitial": "<string>",
        "quantityInitialFormatted": "<string>",
        "quantityRemaining": "<string>",
        "quantityRemainingFormatted": "<string>",
        "quantityAvailable": "<string>",
        "quantityAvailableFormatted": "<string>",
        "quantityDecimals": 123,
        "feeBps": 123,
        "feeBreakdown": [
          {
            "kind": "<string>",
            "recipientAddress": "<string>",
            "bps": 123
          }
        ],
        "validFrom": "<string>",
        "validUntil": "<string>",
        "blockNumber": 123,
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "collectibleId": 123,
        "tokenId": "<string>",
        "orderCreatedAt": "<string>",
        "orderUpdatedAt": "<string>",
        "deletedAt": "<string>"
      },
      "offer": {
        "id": 123,
        "collectionId": 123,
        "orderId": "<string>",
        "chainId": 123,
        "originName": "<string>",
        "collectionContractAddress": "<string>",
        "createdBy": "<string>",
        "priceAmount": "<string>",
        "priceAmountFormatted": "<string>",
        "priceAmountNet": "<string>",
        "priceAmountNetFormatted": "<string>",
        "priceCurrencyAddress": "<string>",
        "priceDecimals": 123,
        "priceUSD": 123,
        "priceUSDFormatted": "<string>",
        "quantityInitial": "<string>",
        "quantityInitialFormatted": "<string>",
        "quantityRemaining": "<string>",
        "quantityRemainingFormatted": "<string>",
        "quantityAvailable": "<string>",
        "quantityAvailableFormatted": "<string>",
        "quantityDecimals": 123,
        "feeBps": 123,
        "feeBreakdown": [
          {
            "kind": "<string>",
            "recipientAddress": "<string>",
            "bps": 123
          }
        ],
        "validFrom": "<string>",
        "validUntil": "<string>",
        "blockNumber": 123,
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "collectibleId": 123,
        "tokenId": "<string>",
        "orderCreatedAt": "<string>",
        "orderUpdatedAt": "<string>",
        "deletedAt": "<string>"
      }
    }
  ],
  "page": {
    "page": 123,
    "pageSize": 123,
    "more": true,
    "sort": [
      {
        "column": "<string>"
      }
    ]
  }
}

{
  "error": "WebrpcEndpoint",
  "code": 0,
  "msg": "endpoint error",
  "status": 400,
  "cause": "<string>"
}

{
  "error": "WebrpcBadResponse",
  "code": -5,
  "msg": "bad response",
  "status": 500,
  "cause": "<string>"
}

Authorizations

X-Access-Key · string · header · required

Public project access key for authenticating requests obtained on Sequence Builder. Example Test Key: AQAAAAAAAEGvyZiWA9FMslYeG_yayXaHnSI

Body

application/json

side · enum<string>

Represented as uint8 on the server side

Available options: unknown, listing, offer

contractAddress · string

filter · object

Show child attributes

page · object

Show child attributes

Response

200

application/json

OK

collectibles · object[]

[]CollectibleOrder

Show child attributes

page · object

Show child attributes